/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.axis.wse.proxy;

import java.util.Vector;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.deployment.SOAPContext;
import cgl.narada.wsinfra.deployment.SOAPContextFactory;
import cgl.narada.wsinfra.deployment.axis.WsInfraAxisHandler;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.IncorrectExchangeException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.exception.UnknownExchangeException;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.wsa.WsaEprCreator;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wse.impl.WseSinkProcessor;

/**
 * @author Damodar Yemme
 * Created on Mar 24, 2005
 * This helper class will create calls from Proxy Sink to Proxy Source and
 * Proxy Subscription Manager.
 */
public class WseSinkProxyHelper
    extends WsInfraAxisHandler {
  private String moduleName = "WseSinkProxyHelper";
  private Vector handlers;
  private WsaEprCreator eprCreator;
  private WseSinkProcessor wseSinkProcessor;
  private EndpointReferenceType sinkEpr;
  private String handlerClassNames;
  private String methodName;
  private static String sinkAddress = WseProxyServicesFactory.getSinkAddress();
  /**
   * Default Constructor for Sink Handler
   * @throws DeploymentException
   */
  public WseSinkProxyHelper() throws DeploymentException {
    eprCreator = WsaProcessingFactory.getWsaEprCreator();
    sinkEpr = eprCreator.createEpr(sinkAddress);
    wseSinkProcessor = WseSinkProcessor.getInstance();
    wseSinkProcessor.setMessageFlow(this);
    wseSinkProcessor.setSinkEPR(sinkEpr);
    handlerClassNames = WseProxyServicesFactory.getHandlerChain();
    methodName = WseProxyServicesFactory.getMethodName();
    this.initilizeInfraAxisHandler();
  }

  /**
   * This will add handler to execute in the chain.
   * @param WsInfraAxisHandler myHandler
   */
  public void addHandler(WsInfraAxisHandler myHandler) {
    handlers.add(myHandler);
  }

  /**
   * This will return SOAPContext from given SOAPMessage
   * @param soapMessage
   * @return SOAPContext
   */
  public SOAPContext getSOAPContext(SOAPMessage soapMessage) {
    SOAPContext soapContext = null;
    try {
      SOAPContextFactory soapContextFactory
          = SOAPContextFactory.getInstance();
      soapContext = soapContextFactory.newSOAPContext(soapMessage);
    }
    catch (DeploymentException dEx) {
      System.out.println(moduleName + " Exception is : " + dEx);
      dEx.printStackTrace();
    }
    return soapContext;
  }

  /**
   * This method will Process Message coming from the network to Sink.
   * @param envelopeDocument
   * @throws IncorrectExchangeException
   * @throws ProcessingException
   * @throws MessageFlowException
   * @throws UnknownExchangeException
   */
  public void processExchange(EnvelopeDocument envelopeDocument,
                              int direction) throws IncorrectExchangeException,
      ProcessingException, MessageFlowException,
      UnknownExchangeException {
    if (direction == WsMessageFlow.FROM_NETWORK) {
      wseSinkProcessor.processExchange(
          envelopeDocument, WsMessageFlow.FROM_NETWORK);
    }
    if (direction == WsMessageFlow.FROM_APPLICATION) {
      boolean validate = wseSinkProcessor.processExchange(
          envelopeDocument, WsMessageFlow.FROM_APPLICATION);
      if (validate) {
        SOAPMessage soapMessage = getSOAPMessage(envelopeDocument);
        enrouteToNetwork(soapMessage);
      }
    }
  }

  /**
   * This method will return SOAPMessage from EnvelopeDocument
   * @param envelopeDocument
   * @return SOAPMessage
   */
  private SOAPMessage getSOAPMessage(EnvelopeDocument envelopeDocument) {
    SOAPMessage soapMessage = null;
    SoapEnvelopeConversion soapEnvelopeConversion = SoapEnvelopeConversion
        .getInstance();
    try {

      soapMessage = soapEnvelopeConversion
          .getSOAPMessage(envelopeDocument);
    }
    catch (ProcessingException ex) {
      String errorReport = "Problems converting to javax.xml.SOAPMessage\n"
          + ex.toString();
      System.out.println(errorReport);
    }

    return soapMessage;
  }
}